---
title: "Get Points Balance"
method: GET
path: "/customers/{user id}/points/balance"
---

# Get Points Balance

`GET /customers/{user id}/points/balance`

Retrieves points balance of a customer from a single program or all programs of the org. Points are aggregated for each Point Category - Main, delayed accrual, and external trigger based.

**This is a light API**.

## Path parameters

- `userId` integer, required

## Query parameters

- `programId` integer
- `entityType` 'CUSTOMER' | 'FLEET'
- `fetchDataForAllPrograms` boolean

## Headers

- `X-CAP-API-OAUTH-TOKEN` string

## Response `200`

200

- object
  - `entityId` integer
  - `entityType` string
  - `totalPoints` number
  - `mainPoints` number
  - `promisedPoints` integer
  - `promisedPointsBreakup` object
    - `delayedAccrualPoints` integer
    - `externalTriggerBasedPoints` integer
  - `warnings` unknown[]
    - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)